Ficha técnica
Seguridad
📘 BTG Id
El servidor de autorización de BTG Empresas se llama BTG Id. Usando BTG Id, una aplicación asociada puede obtener consentimiento y autorización para ejecutar operaciones en las APIs de BTG en nombre del cliente.
Alcances necesarios
El token para consumir la API de Solar Workflow debe ser generado utilizando Client Credentials.
Es necesario utilizar el alcance que se indica a continuación:
| Alcance | Descripción |
|---|---|
brn:btg:empresas:solar:workflow | Permite utilizar las APIs referentes al Workflow de energía solar |
Eventos de Webhook
Los payloads disponibles a continuación representan el contenido del campo data.
| Evento | Descripción |
|---|---|
credito-solar.analyzed | Crédito analizado |
credito-solar.changed-status | Cambio en el estado del análisis |
credito-solar.analyzed
{
"taxId": "00000000000",
"effectiveness": "PreApproved",
"productLimit": 50000.0,
"limitDateExpire": "2024-03-13T00:00:00",
"product": "Solar",
"approvedPaymentTerms": [
{
"gracePeriod": 3,
"installmentsMin": 96,
"installmentsMax": 96,
"monthlyRate": 0.0162,
"yearRate": 0.21,
"monthCet": 0.02,
"yearCet": 0.22,
"amount": 130000.0,
"instalmentAmount": 1350.0
}
],
"originId": "93806596-15dd-4b80-a222-73deeb70d519",
"description": "O valor das parcelas mensais é estimado e poderá variar conforme data de assinatura do contrato de empréstimo, bem como da data escolhida para pagamento das prestações.\nA liberação dos recursos estará condicionada à prévia concordância dos termos do financiamento entre as partes e negociação e preparação de toda a documentação necessária em condições satisfatórias ao BTG Pactual, bem como da análise cadastral completa do Cliente e da perfeita formalização das garantias.\nA presente proposta é válida pelo prazo de 5 (cinco) dias úteis contados da presente data."
}
credito-solar.changed-status
{
"taxId": "00000000000",
"status": "DocumentsAnalysis",
"originId": "93806596-15dd-4b80-a222-73deeb70d519",
"occurrenceDate": "2023-12-11T16:26:29.072171",
"productType": "Solar"
}
Estados posibles:
| Descripción | Estado Anterior | Estado Nuevo |
|---|---|---|
| En espera de análisis interno de los datos de registro | EM_CADASTRO | AccountCreationAnalysis |
| Los datos de registro quedaron pendientes, es necesario ajustar la información | EM_CADASTRO | AccountCreationDataAdjustment |
| Apertura de cuenta rechazada | DOCUMENTOS_REJEITADOS | AccountCreationDisapproved |
| La propuesta expiró en la etapa de apertura de cuenta | VENCIDO | AccountCreationExpired |
| Iniciando apertura de cuenta del cliente | EM_CADASTRO | AccountCreationStartingOnboarding |
| Pendiente envío de formulario de datos de registro | EM_CADASTRO | AccountCreationPendingSubmit |
| Pendiente firma del término de apertura de cuenta | EM_CADASTRO | AccountCreationWaitingSignatures |
| Valor del crédito desembolsado | CONCLUIDO | ContractingOperationDisbursed |
| En espera de contratación del crédito por parte del cliente | AGUARDANDO_DESEMBOLSO | ContractingWaitingOperation |
| Operación contratada, en espera del desembolso del crédito | AGUARDANDO_DESEMBOLSO | ContractingWaitingDisbursement |
| En espera de firmas para la liberación del crédito | AGUARDANDO_DESEMBOLSO | ContractingWaitingSignatures |
| La propuesta fue rechazada en la etapa de contratación | DOCUMENTOS_REJEITADOS | ContractingDisapproved |
| La propuesta expiró en la etapa de contratación | VENCIDO | ContractingExpired |
| En espera de análisis interno de los documentos de comprobación | ANALISE_DOCUMENTACAO | DocumentsAnalysis |
| Los documentos quedaron pendientes, es necesario ajustar la información | AJUSTE_DOCUMENTACAO | DocumentsDataAdjustment |
| La propuesta expiró en la etapa de envío de documentos | VENCIDO | DocumentsExpired |
| Pendiente envío de los documentos de comprobación de la información de la propuesta | PENDENTE_DOCUMENTACAO | DocumentsPendingSubmit |
| Los documentos fueron rechazados | DOCUMENTOS_REJEITADOS | DocumentsDisapproved |
| La propuesta expiró en la etapa de análisis final de crédito | VENCIDO | FinalProposalExpired |
| Propuesta de crédito disponible para aceptación del cliente | AGUARDANDO_ACEITE | FinalProposalPendingAccept |
| En espera de análisis interno de las facturas | ANALISE_DOCUMENTACAO | InvoicesAnalysis |
| Las facturas quedaron pendientes, es necesario ajustar la información | AJUSTE_DOCUMENTACAO | InvoicesDataAdjustment |
| La propuesta expiró en la etapa de envío de facturas | VENCIDO | InvoicesExpired |
| Pendiente liberación del límite del integrador para que la propuesta fluya | N/A | InvoicesPendingLimitAvailability |
| Pendiente envío de las facturas para análisis | ENVIO_NFE | InvoicesPendingSubmit |
| Las facturas fueron rechazadas | DOCUMENTOS_REJEITADOS | InvoicesDisapproved |
| En espera de análisis de crédito interno | EM_ANALISE | LeadViabilityAnalysis |
| La propuesta expiró en la etapa de análisis de viabilidad | VENCIDO | LeadViabilityExpired |
| Pendiente envío de la información básica para la solicitud de crédito | FORMULARIO_PREENCHIMENTO | LeadViabilityPendingSubmit |
| Pendiente ajuste de la información básica para la solicitud de crédito | FORMULARIO_PREENCHIMENTO | LeadViabilityDataAdjustment |
| Propuesta rechazada por crédito | REPROVADO_MOTOR | LeadViabilityDisapproved |